<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader Host: elftosb::BootImageGenerator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader Host
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Host Tools for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classelftosb_1_1_boot_image_generator.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classelftosb_1_1_boot_image_generator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">elftosb::BootImageGenerator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Abstract base class for generators of specific boot image formats.  
 <a href="classelftosb_1_1_boot_image_generator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_boot_image_generator_8h_source.html">BootImageGenerator.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for elftosb::BootImageGenerator:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classelftosb_1_1_boot_image_generator__inherit__graph.svg" width="198" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for elftosb::BootImageGenerator:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classelftosb_1_1_boot_image_generator__coll__graph.svg" width="334" height="410"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af94034bc92bd88bcb3d82d9bf8a0cb36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af94034bc92bd88bcb3d82d9bf8a0cb36"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#af94034bc92bd88bcb3d82d9bf8a0cb36">BootImageGenerator</a> ()</td></tr>
<tr class="memdesc:af94034bc92bd88bcb3d82d9bf8a0cb36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:af94034bc92bd88bcb3d82d9bf8a0cb36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc570a878bc12ecd62bae599867b802e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc570a878bc12ecd62bae599867b802e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#adc570a878bc12ecd62bae599867b802e">~BootImageGenerator</a> ()</td></tr>
<tr class="memdesc:adc570a878bc12ecd62bae599867b802e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:adc570a878bc12ecd62bae599867b802e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f3b5f2e9aaadc1824b3714339e23043"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f3b5f2e9aaadc1824b3714339e23043"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#a1f3b5f2e9aaadc1824b3714339e23043">addOutputSection</a> (<a class="el" href="classelftosb_1_1_output_section.html">OutputSection</a> *section)</td></tr>
<tr class="memdesc:a1f3b5f2e9aaadc1824b3714339e23043"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add another section to the output. <br /></td></tr>
<tr class="separator:a1f3b5f2e9aaadc1824b3714339e23043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20e2a5c01f10947793f17ecb961db440"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20e2a5c01f10947793f17ecb961db440"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#a20e2a5c01f10947793f17ecb961db440">setOptionContext</a> (<a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *context)</td></tr>
<tr class="memdesc:a20e2a5c01f10947793f17ecb961db440"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the global option context. <br /></td></tr>
<tr class="separator:a20e2a5c01f10947793f17ecb961db440"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a906f4abc3d02d86d22ba4ddafb5127bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a906f4abc3d02d86d22ba4ddafb5127bd"></a>
virtual <a class="el" href="classelftosb_1_1_boot_image.html">BootImage</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#a906f4abc3d02d86d22ba4ddafb5127bd">generate</a> ()=0</td></tr>
<tr class="memdesc:a906f4abc3d02d86d22ba4ddafb5127bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pure virtual method to generate the output <a class="el" href="classelftosb_1_1_boot_image.html" title="Abstract base class for all boot image format classes. ">BootImage</a> from input sections. <br /></td></tr>
<tr class="separator:a906f4abc3d02d86d22ba4ddafb5127bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:acff4dacf326ce4a14121da5b7b2b4d64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acff4dacf326ce4a14121da5b7b2b4d64"></a>
typedef std::vector&lt; <a class="el" href="classelftosb_1_1_output_section.html">OutputSection</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#acff4dacf326ce4a14121da5b7b2b4d64">section_vector_t</a></td></tr>
<tr class="memdesc:acff4dacf326ce4a14121da5b7b2b4d64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for a list of model output sections. <br /></td></tr>
<tr class="separator:acff4dacf326ce4a14121da5b7b2b4d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a0f7a5debac63b14bc919c2c5f00a472b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f7a5debac63b14bc919c2c5f00a472b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#a0f7a5debac63b14bc919c2c5f00a472b">processVersionOptions</a> (<a class="el" href="classelftosb_1_1_boot_image.html">BootImage</a> *image)</td></tr>
<tr class="memdesc:a0f7a5debac63b14bc919c2c5f00a472b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle common product and component version options. <br /></td></tr>
<tr class="separator:a0f7a5debac63b14bc919c2c5f00a472b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfa8d846e1b5778c7f979a1534e27eab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfa8d846e1b5778c7f979a1534e27eab"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#adfa8d846e1b5778c7f979a1534e27eab">processDriveTagOption</a> (<a class="el" href="classelftosb_1_1_boot_image.html">BootImage</a> *image)</td></tr>
<tr class="memdesc:adfa8d846e1b5778c7f979a1534e27eab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle the common option which sets the system drive tag. <br /></td></tr>
<tr class="separator:adfa8d846e1b5778c7f979a1534e27eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a137bfb230bafcdf9e1656d885bfb5769"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a137bfb230bafcdf9e1656d885bfb5769"></a>
<a class="el" href="classelftosb_1_1_boot_image_generator.html#acff4dacf326ce4a14121da5b7b2b4d64">section_vector_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#a137bfb230bafcdf9e1656d885bfb5769">m_sections</a></td></tr>
<tr class="memdesc:a137bfb230bafcdf9e1656d885bfb5769"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requested output sections. <br /></td></tr>
<tr class="separator:a137bfb230bafcdf9e1656d885bfb5769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a693b475d9c9ad64950df0fad3f10ee7c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a693b475d9c9ad64950df0fad3f10ee7c"></a>
<a class="el" href="classelftosb_1_1_option_context.html">OptionContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classelftosb_1_1_boot_image_generator.html#a693b475d9c9ad64950df0fad3f10ee7c">m_options</a></td></tr>
<tr class="memdesc:a693b475d9c9ad64950df0fad3f10ee7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Global option context. <br /></td></tr>
<tr class="separator:a693b475d9c9ad64950df0fad3f10ee7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base class for generators of specific boot image formats. </p>
<p>Subclasses implement a concrete generator for a certain boot image format, but they all have the same interface.</p>
<p>After creating an instance of a subclass the user adds <a class="el" href="classelftosb_1_1_output_section.html" title="Base class for data model of sections of the output file. ">OutputSection</a> objects to the generator. These objects describe discrete sections within the resulting boot image file. If the format does not support multiple sections then only the first will be used.</p>
<p><a class="el" href="class_options.html" title="parse command-line options ">Options</a> that are common to all boot image formats are handled by methods defined in this class. These are the current common options:</p><ul>
<li>productVersion</li>
<li>componentVersion</li>
<li>driveTag </li>
</ul>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_boot_image_generator_8h_source.html">BootImageGenerator.h</a></li>
<li>BootImageGenerator.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>elftosb</b></li><li class="navelem"><a class="el" href="classelftosb_1_1_boot_image_generator.html">BootImageGenerator</a></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:49:51 for Kinetis Bootloader Host by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
